<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>aio-grep: SynchronousFileReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">aio-grep
   </div>
   <div id="projectbrief">Grep-like application that uses POSIX AIO file I/O.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_synchronous_file_reader-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SynchronousFileReader Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>File reader that performs synchronous reading. This file reader uses std::getline(...) function to read lines from files. Works on std::string objects.  
 <a href="class_synchronous_file_reader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="synchronousfilereader_8h_source.html">synchronousfilereader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SynchronousFileReader:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_synchronous_file_reader.png" usemap="#SynchronousFileReader_map" alt=""/>
  <map id="SynchronousFileReader_map" name="SynchronousFileReader_map">
<area href="class_file_reader.html" title="Abstract file reader class. Specifies a common interface for all file readers implementations." alt="FileReader" shape="rect" coords="0,0,149,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa7b42b73bed91bf9dbe69c1d9779ca6f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_synchronous_file_reader.html#aa7b42b73bed91bf9dbe69c1d9779ca6f">SynchronousFileReader</a> (int argc, char **argv, <a class="el" href="class_regex_finder.html">RegexFinder</a> *&amp;rf)</td></tr>
<tr class="separator:aa7b42b73bed91bf9dbe69c1d9779ca6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03ea3c5e6bd283b4a98b244edf2bd424"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796f">ReadResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_synchronous_file_reader.html#a03ea3c5e6bd283b4a98b244edf2bd424">readLine</a> (<a class="el" href="class_result_line.html">ResultLine</a> &amp;line)</td></tr>
<tr class="separator:a03ea3c5e6bd283b4a98b244edf2bd424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_file_reader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_file_reader')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_file_reader.html">FileReader</a></td></tr>
<tr class="memitem:a615dcb2443cad1f2ca123c7c0c334480 inherit pub_methods_class_file_reader"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a615dcb2443cad1f2ca123c7c0c334480"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_reader.html#a615dcb2443cad1f2ca123c7c0c334480">FileReader</a> ()</td></tr>
<tr class="memdesc:a615dcb2443cad1f2ca123c7c0c334480 inherit pub_methods_class_file_reader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty constructor. <br/></td></tr>
<tr class="separator:a615dcb2443cad1f2ca123c7c0c334480 inherit pub_methods_class_file_reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addc591dc8120f70da096ffd3365071b9 inherit pub_methods_class_file_reader"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_reader.html#addc591dc8120f70da096ffd3365071b9">FileReader</a> (int argc, char **argv, <a class="el" href="class_regex_finder.html">RegexFinder</a> *&amp;rf)</td></tr>
<tr class="memdesc:addc591dc8120f70da096ffd3365071b9 inherit pub_methods_class_file_reader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes object to perform reading.  <a href="#addc591dc8120f70da096ffd3365071b9"></a><br/></td></tr>
<tr class="separator:addc591dc8120f70da096ffd3365071b9 inherit pub_methods_class_file_reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ddc14179401245f69f75ef32610132d inherit pub_methods_class_file_reader"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_reader.html#a5ddc14179401245f69f75ef32610132d">setRegexFinder</a> (<a class="el" href="class_regex_finder.html">RegexFinder</a> *&amp;reg)</td></tr>
<tr class="separator:a5ddc14179401245f69f75ef32610132d inherit pub_methods_class_file_reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_file_reader"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_file_reader')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_file_reader.html">FileReader</a></td></tr>
<tr class="memitem:a8e801198c62f657dd1dff8fd8dbe796f inherit pub_types_class_file_reader"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796f">ReadResult</a> { <b>FR_GOOD</b>, 
<a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796fae9f73ad13d7812bd5c4d0e6bd4c98757">FR_BAD</a>, 
<a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796fa677d417bbb7f32f5fc9c07717bf7a036">FR_NO_MORE</a>, 
<a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796fa2d89c82783e7e6491174d0c1a1302ffe">FR_OPEN_FAILED</a>
 }</td></tr>
<tr class="memdesc:a8e801198c62f657dd1dff8fd8dbe796f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the status of file reader.  <a href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796f">More...</a><br/></td></tr>
<tr class="separator:a8e801198c62f657dd1dff8fd8dbe796f inherit pub_types_class_file_reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_file_reader"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_file_reader')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_file_reader.html">FileReader</a></td></tr>
<tr class="memitem:af8ad2862e80be4d46ee35570db428f3c inherit pro_attribs_class_file_reader"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8ad2862e80be4d46ee35570db428f3c"></a>
<a class="el" href="class_regex_finder.html">RegexFinder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_reader.html#af8ad2862e80be4d46ee35570db428f3c">regexFinder</a></td></tr>
<tr class="memdesc:af8ad2862e80be4d46ee35570db428f3c inherit pro_attribs_class_file_reader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to regex finder object. <br/></td></tr>
<tr class="separator:af8ad2862e80be4d46ee35570db428f3c inherit pro_attribs_class_file_reader"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File reader that performs synchronous reading. This file reader uses std::getline(...) function to read lines from files. Works on std::string objects. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa7b42b73bed91bf9dbe69c1d9779ca6f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SynchronousFileReader::SynchronousFileReader </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_regex_finder.html">RegexFinder</a> *&amp;&#160;</td>
          <td class="paramname"><em>rf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd>{<a class="el" href="class_file_reader.html" title="Abstract file reader class. Specifies a common interface for all file readers implementations.">FileReader</a>} </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a03ea3c5e6bd283b4a98b244edf2bd424"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file_reader.html#a8e801198c62f657dd1dff8fd8dbe796f">FileReader::ReadResult</a> SynchronousFileReader::readLine </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_result_line.html">ResultLine</a> &amp;&#160;</td>
          <td class="paramname"><em>line</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See Also</dt><dd>{<a class="el" href="class_file_reader.html" title="Abstract file reader class. Specifies a common interface for all file readers implementations.">FileReader</a>} </dd></dl>

<p>Implements <a class="el" href="class_file_reader.html#aa5e7dfefb3249a68497e40ddc0fd37f8">FileReader</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="synchronousfilereader_8h_source.html">synchronousfilereader.h</a></li>
<li>src/synchronousfilereader.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 7 2013 20:25:30 for aio-grep by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
